Appointment Management API - TMF646
API Data Dictionary - Provision - POST searchTimeSlot
API Request Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| appointmentType | Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| category | Provision | Extension to the API. It defines the Type of the Appointment whether Repair, Order provisioning or Order Modification. |
| installationType | No site visit Standard Premium Advanced |
Extension to the API. |
| telecare | boolean | Extension to the API. Boolean. Whether this is a vulnerable customer. |
| isUPS | boolean | Extension to the API. Boolean. Whether providing UPS installation is required. |
| productName | C-BIP-FTTP C-BIP-FTTC C-BIP-ADSL |
Extension to the API. A product name that is sent by Partners to Mulesoft. |
| provisioningCommand | Provision Select, etc. | Extension to the API. A provisioning command sent by Partners to Mulesoft. |
| technology | WBB + fiber | Extension to the API. Sent by Partners to Mulesoft. |
| requestedTimeslot | See requestedTimeslot table | array |
| productId | C-BIP-FTTP | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| serviceId | Extension (displayed when provisioning command) | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| appointmentExecutionStatus | Exists (depending on provisioning command) | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| relatedEntity | See relatedEntity table | array contains the BillingAccount element |
| interactionPlace | See interactionPlace table | array |
| @type | PXCAppointment | |
| @baseType | Appointment |
API Response Payload
| HTTP Header Name | Example Field Value | Description |
|---|---|---|
| Correlation-ID | c97ded75-44fa-4b69-9f3b-01d513a41efe | A GUID to relate requests belonging to the same transaction |
| Payload Field Name | Example Field Value | Description |
|---|---|---|
| searchDate | 2025-02-01T14:48:45.071Z | Timestamp of when the searchTimeslot request was performed. |
| searchResult | success | Result of the searchTimeslot. Will be set to success. |
| category | Provision | Extension to the API. It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification. |
| appointmentType | Standard Flexible |
Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers. |
| installationType | No site visit Standard Premium Advanced |
Extension to the API. |
| telecare | boolean | Extension to the API. Boolean. Whether this is a vulnerable customer. |
| isUPS | boolean | Extension to the API. Boolean. Whether providing UPS installation is required. |
| productName | C-BIP-FTTP C-BIP-FTTC C-BIP-ADSL |
Extension to the API. A product name sent by Partners to Mulesoft. |
| provisioningCommand | Provision Select, etc. | Extension to the API. A provisioning command sent by Partners to Mulesoft. |
| technology | WBB + fiber | Extension to the API. Sent by Partners to Mulesoft. |
| description | Fix an internet connection problem for a customer | Extension to the API. Description used by partners. |
| requestedTimeslot | See requestedTimeslot table | array |
| productId | C-BIP-FTTP | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| serviceId | Extension (displayed when provisioning command) | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| appointmentExecutionStatus | Exists (depending on provisioning command) | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| relatedParty | See relatedParty table | Extension to the API. Supplied by Mulesoft on the internal interface for Amex. |
| relatedEntity | See relatedEntity table | array contains the BillingAccount element |
| availableTimeslot | See availableTimeslot table | array |
| status | done | Status of the searchTimeslot. Will be set to done. |
| @type | PXCSearchTimeSlot | |
| @baseType | SearchTimeSlot |